home *** CD-ROM | disk | FTP | other *** search
/ Euroscene 2 / Euroscene 2.iso / USEFUL / libs / Workbench / ShowIFF.doc < prev    next >
Encoding:
Text File  |  1995-11-01  |  7.1 KB  |  220 lines
  1.  
  2.        ShowIFF - a comfortable IFF picture viewer for CLI and Workbench
  3.        ----------------------------------------------------------------
  4.  
  5.                           Version 2.24, 14-Jan-91
  6.  
  7.  
  8.                       This program and iff.library by:
  9.  
  10.         Christian A. Weber, Bruggerweg 2, CH-8037 Zürich, SWITZERLAND
  11.  
  12.            Any suggestions or bug reports are welcome, e-mail to:
  13.  
  14.     UUCP:     {uunet|pyramid|rutgers}!cbmvax!cbmehq!cbmswi!mighty!chris
  15.     INTERNET: cbmehq!cbmswi!mighty!chris@cbmvax.commodore.com
  16.     BIX:      chw
  17.  
  18.  
  19.  
  20. THIS PROGRAM IS IN THE PUBLIC DOMAIN.  IT MAY BE FREELY DISTRUBUTED, COPIED
  21. AND USED FOR COMMERCIAL OR NON-COMMERCIAL PURPOSES. YOU ARE ALLOWED TO MAKE
  22. CHANGES TO THE SHOWIFF.* FILES AS LONG AS YOU CLEARLY MARK THE CHANGES.
  23.  
  24.  
  25. DISCLAIMER
  26.  
  27. THIS SOFTWARE IS PROVIDED "AS IS".
  28. NO REPRESENTATIONS OR WARRANTIES ARE MADE WITH RESPECT TO THE ACCURACY,
  29. RELIABILITY, PERFORMANCE, CURRENTNESS, OR OPERATION OF THIS SOFTWARE, AND
  30. ALL USE IS AT YOUR OWN RISK. YOU ALREADY KNEW THAT, DIDN'T YOU. THE AUTHOR
  31. ASSUMES NO RESPONSIBILITY OR LIABILITY WHATSOEVER WITH RESPECT TO YOUR USE
  32. OR INABILITY TO USE OF THIS SOFTWARE.
  33.  
  34.  
  35.                                     ***
  36.  
  37.  
  38. FEATURES
  39. --------
  40.  
  41. - All known formats of IFF pictures (including Overscan, HAM, Halfbrite,
  42.   S-HAM) are supported. If a picture is larger than the screen, you may use
  43.   the mouse to scroll around (If you have enough CHIP memory...)
  44.  
  45. - Runs from both Workbench and CLI, creates an AppIcon under Kickstart 2.x
  46.  
  47. - Uses double-buffering for best results if enough CHIP RAM is available
  48.  
  49. - Can be used for demonstrations and slide-shows, see below
  50.  
  51. - Powerful command option, for copying, deleting or archiving pictures
  52.  
  53.  
  54.  
  55. REQUIREMENTS
  56. ------------
  57.  
  58. ShowIFF requires the arp.library and, of course, the iff.library. These
  59. two files should be located in the LIBS: directory.
  60.  
  61.  
  62.  
  63. WORKBENCH USAGE
  64. ---------------
  65.  
  66.  
  67. Under Kickstart 1.3:
  68.  
  69.   Select all pictures you wish to view while pressing the SHIFT key, then
  70.   double-click the ShowIFF icon.
  71.  
  72.   You can also set the picture's default tool to 'ShowIFF' using WorkBench's
  73.   'Info' feature.
  74.   If you wish to display all the pictures in a drawer, select the drawer, and
  75.   while depressing the SHIFT key, double-click the ShowIFF icon. This works
  76.   even with disk icons!
  77.   If a drawer or disk contains another drawer, the pictures in that drawer
  78.   will also be displayed.
  79.  
  80.  
  81. Under Kickstart 2.x:
  82.  
  83.   Under Kickstart 2.x you have an additional possibility, which you may
  84.   prefer once you are familiar with Kickstart 2.x: You can put ShowIFF in
  85.   your WBStartup drawer. When you boot your Amiga, ShowIFF is automatically
  86.   started and creates an "AppIcon". This icon looks like any other icon, and
  87.   you can freely chose it's name and it's position (see below). But this
  88.   icon has an interesting feature: You can view a picture by simply dragging
  89.   the icon of that picture on ShowIFF's AppIcon. This works for drawers and
  90.   disks too, of course.
  91.   If you wish to remove the ShowIFF AppIcon, simply start ShowIFF again.
  92.  
  93.  
  94. Tool Types:
  95.  
  96.   ShowIFF understands several tool types. You can edit them using the
  97.   "Show Information" or "Info" commands from the Workbench menu. Here's
  98.   a list of the recognized tool types:
  99.  
  100.   ICONXPOS     Specifies the x coordinate of ShowIFF's AppIcon. This works
  101.                only under Kickstart 2.x and above.
  102.                Example: ICONXPOS=620
  103.  
  104.   ICONYPOS     Specifies the y coordinate of ShowIFF's AppIcon. This works
  105.                only under Kickstart 2.x and above.
  106.                Example: ICONYPOS=120
  107.  
  108.   ICONNAME     Specifies the name of ShowIFF's AppIcon (Only Kickstart 2.x).
  109.                Example: ICONNAME=IFF Viewer
  110.  
  111.   OPTIONS      Here you can specify several options, in the same format as
  112.                if you would enter them from CLI. Works under 1.3 too.
  113.                Example: OPTIONS=ALL DELAY 5 NOOVERSCAN LOOP
  114.  
  115.  
  116.  
  117. CLI USAGE
  118. ---------
  119.  
  120.  
  121. The template is:
  122.  
  123. Patterns/...,ALL/s,L=LOOP/s,D=DELAY/k,NB=NOBREAK/s,NO=NOOVERSCAN/s,COMMAND/k
  124.  
  125. ShowIFF [files or patterns] [ALL] [LOOP] [DELAY delay] [NOBREAK]
  126.                 [NOOVERSCAN] [COMMAND "Command %s args"]
  127.  
  128.  
  129. Example: ShowIFF Lo-Res/Pic* Hi-Res/foo RAM:#? ALL DELAY 7
  130.  
  131.  
  132. files          can be any number of file names, directories or disk names.
  133.                All of the ARP wildcards can be used. (?,*,#?,...)
  134.  
  135. ALL            if this keyword is specified, pictures in sub-directories
  136.                will also be displayed.
  137.  
  138. LOOP           if specified, repeatedly displays the pictures, which is
  139.                useful for creating slide-shows or presentations.
  140.  
  141. DELAY seconds  specifies the delay between two pictures in seconds. If not
  142.                specified, the delay is infinity. Note that you can always go
  143.                to the next picture by pressing the left mouse button.
  144.  
  145. NOBREAK        disables the breaking features described below. Together with
  146.                the LOOP keyword, a neverending and un-stoppable slideshow
  147.                can be created.
  148.  
  149. NOOVERSCAN     display all pictures in the size of the Workbench screen, and
  150.                never in overscan. This is useful if you want to see every
  151.                pixel of a picture. NOOVERSCAN is automatically activated if
  152.                the picture is too large to fit on an overscan screen. In
  153.                this case you can use the mouse to scroll around.
  154.  
  155. COMMAND cmd %s command to execute whenever the user presses the 'C' key
  156.                while the picture is displayed. Examples:
  157.  
  158.               - You have a large collection of pictures and want to copy the
  159.                 best of them to to another disk. To do this, type
  160.  
  161.                   ShowIFF * ALL COMMAND "Copy %s to DF1:"
  162.  
  163.                 and hit the 'C' key on every picture you want to copy.
  164.  
  165.               - You want to delete the pictures you don't like. Type
  166.  
  167.                   ShowIFF * COMMAND "Delete %s" ALL
  168.  
  169.                 and hit 'C' on each picture you want to delete.
  170.  
  171.                The special parameter "%s" is automatically converted to the
  172.                actual file name.
  173.  
  174.  
  175.  
  176. KEYS AND MOUSE-BUTTONS
  177. ----------------------
  178.  
  179. While a picture is displayed, you can press the following keys:
  180.  
  181.  
  182. LEFT MOUSE BUTTON
  183.  
  184.   Display the next picture. If there are no more pictures to show, ShowIFF
  185.   closes its window and terminates.
  186.   If in AppIcon mode, ShowIFF closes its window and waits for new pictures.
  187.  
  188.  
  189. RIGHT MOUSE BUTTON
  190.  
  191.   Abort immediately
  192.  
  193.  
  194. Ctrl-C (if the ShowIFF window or the CLI window is active)
  195.  
  196.   Abort immediately
  197.  
  198.  
  199. Ctrl-E (if the ShowIFF window or the CLI window is active)
  200.  
  201.   If you started ShowIFF from Workbench, ore enabled the "ALL" option from
  202.   CLI, pressing Ctrl-E will skip all pictures in the current sub-directory,
  203.   and return to the parent-directory (like in the CLI "Dir" command).
  204.  
  205.  
  206. 'C' key
  207.  
  208.   If you specified a command using the COMMAND keyword, this command is
  209.   executed. If no command was given, nothing happens.
  210.  
  211.  
  212. MOVE THE MOUSE
  213.  
  214.   If the actual picture is larger than the screen, the visible portion will
  215.   scroll according to your mouse movement.
  216.  
  217.   Note:  HAM pictures may have color distortions on the left side. This is
  218.          a hardware limitation of the HAM mode, and not a bug in ShowIFF.
  219.  
  220.